home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / ubfile17.zip / UBFILE.DOC < prev    next >
Text File  |  1991-08-25  |  20KB  |  369 lines

  1.                               UBFILE ver 1.7
  2.                               For Ultra BBS 2+
  3.  
  4.  
  5. Important! Please read the following paragraphs and if it fits your situation
  6. then please read the instructions on separating files.  This is a Beta Test
  7. of UBFILE so make sure you back up all your data before using this program.
  8. Please Make sure your ID names are all 4 charactors long.
  9.  
  10.   How you use UBFILE is dependent on your present directory setup.  Due to the
  11. fact that moving files is difficult I would assume that many users have only
  12. a limited number of physical file directories.  The number of directory ID's
  13. could be extensive.  This situation has some good and bad points.  Files are
  14. in a centralized area and no physical moving is required.  One drawback is
  15. that it is very difficult to split files to different drives and directories
  16. if you are running low on disk space.  Many utilities such as ones that make
  17. new ZIP headers slow down as the number of files increases.  The situation is
  18. not too bad for small BBS;s but when you have over 3000 files like I do, you
  19. need more than a couple of directories to hold them.  I still like to be
  20. able to go to my Games directory and just see game files, not 300 games mixed
  21. in with 1000 other files.  If you do not have separate physical directories
  22. for your ID's then make sure you read the section of separating files.  Serious
  23. damage can be done to your files if you blindly use this program.
  24.  
  25.  
  26. Ver 1.7 - Fixes a few critters that slipped past me in version 1.6
  27.  
  28.           If no files were in a directory and you used the Record
  29.           Editor and just started typing in the information instead
  30.           of pressing F2 to add a file record was getting assigned
  31.           an improper record number.
  32.  
  33.           Changed a timed pause on displaying a Registered Feature Only
  34.           window to require a keystroke to exit.  One of the testers
  35.           reported getting scrambled screen displays with the timed
  36.           function.
  37.  
  38.           Fixed (Hopefully) a problem with the Page Down function that
  39.           would not show the last page if two or fewer records were
  40.           on the last page.
  41.  
  42.           Added still more code to remove any spaces from filenames that
  43.           are added with the Unlisted File import.  If anyone has any
  44.           trouble with files not being found for downloading that were
  45.           imported with the Text File Import or Unlisted File import
  46.           please let me know about it.  At the time of release the only
  47.           trouble I heard about was people who used Tick Generated text
  48.           files from Remote Access.  Any errors should be fixed
  49.           by running the enclosed FIXDATA.EXE.  Please read Fixdata.Doc
  50.           for instructions.
  51. New Features in ver 1.6
  52.  
  53. Each ID can contain up to 1000 Files. (500 Unregistered)
  54.  
  55. Adds files in directory but not in database automatically
  56.  
  57. Sort Screen display by Date or Filename (Registered version only)
  58.  
  59. Textfile import now supports up to 5 lines of descriptions
  60.  
  61. Added the Zip file viewer to the record editor
  62.  
  63. Removed Memory block size from Ubfile.CFG - 2nd line now contains Sysop's name
  64.  
  65.  
  66. Ver 1.5
  67.  
  68. Features:
  69.  
  70. Works with either Version 1.11 or Version 2.0 of Ultra.
  71.  
  72. View and Edit files on directory by directory basis.
  73.  
  74. Supports up to 200 directories.
  75.  
  76. Tag up to 100 files at a time for deletion or moving.
  77.  
  78. View inside archives and read docs. (Requires PKUNZIP in path)
  79.  
  80. Edit full records and descriptions from scrolling list.
  81.  
  82. Can be used while multinode BBS is operating.
  83.  
  84. Global change features for ID names and Paths.
  85.  
  86. Utilities for reading in Text file lists from other BBS programs.
  87.  
  88. Updates Filebase Index files.
  89.  
  90. Edit Text files in DOS directories (Requires Qedit or similar text editor).
  91.  
  92.  
  93.  
  94. SETUP
  95.  
  96.   UBFILE must be run from the same directory that contains your FILEBASE.DAT
  97. files.  Unzip UBFILE.EXE and UBFSET.EXE into that directory.  Make sure that
  98. a copy of PKUNZIP is available through your path statement or is also in
  99. the same directory.  Create a file called UBFILE.CFG in the same directory
  100. and enter the name of your text file editor on the first line.  The Second
  101. line is the number of records to read into meory.  The larger the number
  102. the faster UBFILE will operate.  This should be a number between 100 and 500.
  103. Ubfile takes approximatly 270K to run.  Each multiple of 100 adds about
  104. 33K to that number when the Filebase is being read so if you don't have
  105. a lot of memory then keep the number on the low side.  A disk cache will
  106. also greatly increase the speed of operation.
  107.  
  108.    If you have a separate physical path for every file ID then setting up
  109. UBFILE is simple.  Just run the included setup file once to create a small
  110. index file containing your ID's and Paths. This file is used throughout the
  111. program to locate directories and move files.  If you have no files online
  112. the procedure is a little more complicated.  You must first run UBFILE and
  113. enter the GLOBAL MENU and choose Add ID's.  You must now physically add your
  114. ID's and paths to the index file.  Make sure that type in all the information
  115. correctly as it is not very easy to correct mistakes once you enter it in.
  116. There has been some trouble handling ID names of less than 4 charctors. It
  117. is suggested that you expand all your ID's to 4 letters to prevent any
  118. errors in the operation of this program.
  119.  
  120.                          SEPERATING FILES
  121.  
  122.  
  123.    If you have many ID names and do not have separate physical drives then
  124. read the following information carefully.  First use UBFSET.EXE to copy infor-
  125. mation from your FILEBASE.DAT file.  In order to separate your files into
  126. other directories you must first Create new ID's with different paths.  For
  127. example if you have an ID called GAME with a path of C:\UBBS\FILES then use
  128. the ADD an ID function to create an ID called\ GAM2 or something similar.  Enter
  129. a path different then the current path of the GAME files.  Entering the current
  130. location of your game files into the new ID Path could result in deletion of
  131. files.  Do the same thing for all your ID's.  A good idea is to name your
  132. DOS directories the same as your 4 letter ID's.  It makes it a lot easier
  133. to keep track of things.  Once you have all your present ID's duplicated with
  134. slightly different names you can begin moving files.  Once all your files have
  135. been moved to the proper location you can then go back and delete the old ID
  136. names.  If you like you can use the Rename ID feature to change the new ID
  137. names back to the old ones.  Although this method takes a bit longer it sure
  138. is faster then typing in 1000 paths one at a time.
  139.  
  140.    If you have Multiple Paths for an ID then you are in for a bit of work
  141. before you can use UBFILE.  This program is based on the assumption that
  142. you only have one path for Each ID.  Any attempts to move files with this
  143. configuration could have disasterous effects.  DO NOT use UBFSET.EXE if you
  144. have multiple paths for an ID since the program reads the file path of the
  145. first occurance of an ID and enters that path as the default.  Use ADD ID
  146. to enter in all your ID's and PATHS before using UBFILE to move any files.
  147.  
  148.  
  149. USING UBFILE
  150.  
  151.   UBFILE is broken into three main parts: Editor,Global, and Utilities.  All
  152. three sections contain useful features for maintaining and updating your
  153. filebase.
  154.  
  155.                               EDITING FILES
  156.  
  157.   When you choose EDIT FILES you are presented with a scrolling list of your
  158. ID's.  Use the arrow keys to scroll up and down through the list and hit enter
  159. to select the ID you would like to edit.  If you remember all the numbers of
  160. your ID's then you can enter that number instead of scrolling through the list.
  161. At this point UBFILE reads your FILE- BASE.DAT file and picks out only those
  162. files that match the selected ID.  This process varies in length depending on
  163. the speed of your hardware.  If you are running on a XT with a slow hard drive
  164. and have a large data file then the process could take a bit of time so be
  165. patient.  A small window then pops up prompting if you wish to look for unlisted
  166. files.  If you enter Y and enter then the bottom of your filelisting will
  167. display any files in the assigned directory that are not contained in the
  168. database.  All unlisted files will be assigned the record number of 99999
  169. until one of the fields of the record is changed (most likely description
  170. added) in the record editor.
  171.  
  172.   Once the program is done sorting the files you are presented with
  173. a scrolling list of all files that are in the selected ID.  Use the arrow keys
  174. and pageup-pagedown keys to move though the list.
  175.  
  176.  
  177. RECORD EDITOR - If you hit enter on a file then a large window pops up con-
  178. taining the complete record for editing.  You may change any information in
  179. the record including the filename.  The pagedown-pageup keys may also be used
  180. to view complete records while maintaining the current cursor location.  This is
  181. handy if you want to change the same field on many records. If a record is
  182. changed and either the page up or page down key is hit then the record is saved
  183. to disk automatically.  If you hit the escaped key then you are asked
  184. if you want to save the changes.  If you change the filename make sure you also
  185. change the filename in the path field or the BBS will not be able to find the
  186. record.
  187.  
  188. SELECTING FILES - When viewing the scrolling list of files up to 100 files may
  189. be marked by using the space bar.  Using the space bar on a previously marked
  190. file will unmark it.  A small check mark is placed on the left of the ID name
  191. to signify that it has been marked for a future operation.  All files that
  192. are marked will have the same operation performed on them.  If 20 files are
  193. marked then all 20 files would be moved to the same location if the F5 key
  194. is used.  Use caution with the space bar.  I have used it to mark files
  195. and forgotten about them.  I paged down a few time and hit F4 to delete files.
  196. The files that were selected were all marked for deletion even though I had
  197. planned to move them.  If you do the same thing then just use the space bar
  198. to unmark them and correctly set the function before you exit and save the
  199. changes.
  200.  
  201. MOVING FILES - The F5 key is used to move selected files.  All selected
  202. files must be moved to the same directory ID.  The F5 key may also be used
  203. without selecting files with the space bar.  A list appears and you choose the
  204. new ID by using the arrow key to scroll to your choice and selected with the
  205. enter key.  After you select the ID the check mark will change to a M and
  206. the old ID will be changed on the screen to the new one.  Remember that no
  207. actual moving of files has taken place yet and the procedure can be aborted
  208. by hitting the escape key and answering N to save changes.  If you answer
  209. Y then the physical move of the file(s) will take place and all ID's and
  210. paths will be changed in the FILEBASE.DAT and INDEX files.  To unmark files
  211. you may hit the space bar.  It will then revert back to a check mark.  If
  212. you desire to remove the check mark then hit the file with the space bar again
  213. and it will disappear.
  214.  
  215. DELETING FILES - The F4 key works the same as the F5 key for deleting selected
  216. or individual files.  You are prompted to make a decision to delete the File(s)
  217. from the Record, Drive, or both.  Choosing Record will set the delete flag to
  218. yes on all the selected files.  Choosing Drive will physically delete the files
  219. from your hard drive while leaving it in the record and choosing both will Set
  220. the delete flag and physically delete the files.  No changes are actually made
  221. until you hit escape and answer Y to save changes.
  222.  
  223. VIEW ZIP - If you have PKUNZIP in your path use F3 to view the files contain-
  224. ed in the archive file and also read any text file.  I get files in my upload
  225. directory all the time with either missing or bad descriptions.  Usually if
  226. you are in the manager you have to exit, use shez or some other utility to
  227. read the doc file then load up manager again to edit the description.  This can
  228. be tedious for more than a couple of files.  Presently only .ZIP files are
  229. supported but .ARC and LZH may be added into a future version.  The zip file
  230. viewer is available in either the file list or record editor windows.
  231.  
  232. DOS Directory - This function presents you with a scrolling list of files
  233. in the current directory.  Hitting enter on a file will allow you to
  234. view or edit the file with an external program.  The name of your text
  235. editor is placed on the first line of UBFILE.CFG.  Make sure the editor
  236. is either in the same directory or somewhere in your DOS filepath.  Enter
  237. the name of your editor in the FILENAME.EXT format such as EDIT.EXE.  Help
  238. is built into the directory module and is accessed with F1.
  239.  
  240. SORT - Registered versions only - Using the F-7 key will sort all the files
  241. on your display by filename.  F-8 will sort by filedate.  The sort only
  242. affects the screen display and actual sorting of the database is done with
  243. a combination of QSORT and MANAGER in Ultra.
  244.  
  245.                              GLOBAL MENU
  246.  
  247.    The Global menu gives you the opportunity to make system-wide changes to
  248.  a selected group of records.  I've included functions that appear to be
  249.  useful to me.
  250.  
  251. CHANGE ID NAME - Should you desire to rename one of you file ID's this function
  252. will update all records and index files with the new ID.  The number of records
  253. updated is shown on the screen.
  254.  
  255. NEW ID LOCATION - This selection will allow you to change the location of files
  256. associated with any ID.  It will not physically move files.  All records and
  257. index files are updated with the changes.  If you used a File move program
  258. to physically move your programs or reassigned network drives then this
  259. feature is very useful to change all the paths for the ID at once.
  260.  
  261. ADD ID - Allows you to add a new ID to UBFILES index file.  Once a new ID is
  262. added then files may be imported or moved to the new ID.  This feature does
  263. not add the new ID to your Conference Data File and you my use Ultra's Setup
  264. program to add them.  The reason for this is that each conference could have
  265. different ID's associated with them and I have no idea of which Conferences
  266. you would like the new ID inserted.  ADD ID will create the new filepath if
  267. it does not exist.
  268.  
  269. DELETE ID - Deletes an ID from the UBFILE index file.  Files with this ID are
  270. not deleted from the FILEBASE.DAT nor are files physically deleted.  The
  271. purpose of this command is to delete an ID from the scrolling selection list
  272. if you are no longer using it.  If you want to actually delete files from the
  273. disk or database then use the Editor to mark and delete files.  If you make
  274. a mistake and delete the wrong ID just use ADD ID an everything will be back
  275. to normal.  This feature does not Delete ID's from your Conference Data File.
  276.  
  277.                           UTILITY MENU
  278.  
  279. IMPORT FILELIST - This selection will allow you to import other BBS lists into
  280. Ultra's database.  You can specify at which column each item starts but the
  281. length is fixed to Ultra's parameters.  Most BBS text lists have the following
  282. format:
  283.  
  284.         FILENAME   SIZE  DATE    DESCRIPTION
  285.  
  286.   What does vary though is the starting position of each block of information.
  287. Each line of text is made up of 80 characters and although the filename usually
  288. starts at character #1 the rest of the information could vary in position.
  289.  
  290. 1             15       24        34
  291. GAME.ZIP        32451  11/04/91  New shareware game. Supports 3D 256 color VGA
  292.  
  293.   The above example is the PCBOARD Textfile format.  A different BBS could
  294. have the description start at 35 instead of 34.  The size and date could also
  295. be reversed.  In order to accommodate different style file lists UBFILE allows
  296. you to specify the starting position of each item. Default starting posistions
  297. are installed for PCBoard style directories so if you are converting from
  298. PCBoard or your start points are the same as the defaults then just hit
  299. enter.  If your data start point is different then type in the new value.
  300. If you are unsure of where each item starts then use a text editor such as
  301. QEDIT which will tell you which column and row the cursor is on.
  302.  
  303.    There only two rules for entering in the starting posistions. File dates
  304. must be in the MM-DD-YY format and be separated by some sort of charactor such
  305. as / or - .  The most important rule is that there must be a charactor in
  306. column #1.  This is because if there is no character in that posistion then
  307. IMPORT will skip that line.  Experiment importing some small directories before
  308. you spend a lot of time doing all of them.  Check the display in the Filelist
  309. and Record editor and make any necessary changes to your format. UBFILE supports
  310. 5 description lines of 45 characters which is also the Ultra limit.  As with
  311. the filename make sure that there is a character in the starting posistion of
  312. each line of the file desscription or it will be skipped.
  313.  
  314.   The final two prompts are for the TEXTFILE to Import and the PATH of the
  315. files.  Enter the full path of the imported text file such as:
  316.   C:\BBS\GAMES.DIR
  317.  
  318. The path to the files in this directory is entered into the last prompt
  319. such as:
  320.   C:\FILES\GAMES
  321.  
  322.  
  323.   You do not need to use ADD ID prior to using IMPORT since this procedure will
  324. automatically add all required information into the index file.  Import will
  325. also create your filepaths if they do not exist.
  326.  
  327. CREATE FILELIST - This function allows you to pick and choose area ID's that
  328. you would like a text filelist created.  A scrolling list of ID's is presented
  329. and you chose areas by using the space bar.  If you would like all areas listed
  330. then enter A.  If you would only like a listing of one area then you may just
  331. scroll to the ID and hit enter.  The next screen asks you for the filename
  332. you would like the listing to be called.  The default is ALLFILES.BBS and if
  333. that's fine you may just hit enter.  To clear the box you may use ALT D or the
  334. backspace key and enter in any filename you wish. All filelists contain the
  335. number of files and bytes for each directory and a running total of both values
  336. for all directories which is displayed at the bottom of your text file.
  337.  
  338.  
  339.  
  340.                            REGISTRATION
  341.  
  342. Registration of UBFILE is $20.  Since UBFILE has about 400 hours of
  343. work in it so far I feel that it's a steal...unless you don't register
  344. is at all after 30 days...then it's really a steal!  As a precaution
  345. against use over the 30 day evaluation period code has been incorporated
  346. into UBFile that will misspell words while type messages in the Ultra
  347. Support conference making all who read them think you are a graduate
  348. of a group home.
  349.  
  350.  
  351.                            SUPPORT
  352.  
  353.   The latest version of UBFILE and other software I've written is always
  354.   available on my Bulletin Board.  New Users can only download 1 file so
  355.   make it a good one.  If you are running Front Door or other compatable
  356.   mailer then you may Freq the latest version of UBFILE by requesting
  357.   UBFILE  or a list of all files on my system with the code word of FILES.
  358.   Only HST Freqs are currently supported.  If you are calling with a V.32
  359.   only mode or 2400 then you will have to log on the BBS.
  360.  
  361.   Please Send any Checks, suggestions, or 600 meg CD WORM drives to:
  362.  
  363.                         Ken Serikstad
  364.                        Knight Moves BBS
  365.                         42 Camden St.
  366.                       Rochester,NY 14612
  367.                      BBS - 716-865-2106 HST
  368.                         FIDO 1/260/213
  369.